Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mask Generation Task Guide #28897

Merged
merged 28 commits into from
Feb 14, 2024
Merged

Conversation

merveenoyan
Copy link
Contributor

Added mask generation task guide.

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Contributor

@MKhalusova MKhalusova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, @merveenoyan ! Left some suggestions.

on labeled datasets and are limited to the classes they have seen during training; they return a set of masks and corresponding classes,
given an image.

Mask generation models are trained on large amounts of data, and they operate in two modes. The first one is prompting
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Large amounts of unlabeled data?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the model is actually manually labeled with masks, semi-automatic labeled, and fully automatically labeled, however the label here doesn't imply class masks like fully supervised image segmentation. will try to put this properly

given an image.

Mask generation models are trained on large amounts of data, and they operate in two modes. The first one is prompting
mode. In this mode, the model takes in an image and a prompt, where a prompt can be a point location in the image within
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is a point location an XY coordinate of a pixel or something else?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes it is, will clarify

on labeled datasets and are limited to the classes they have seen during training; they return a set of masks and corresponding classes,
given an image.

Mask generation models are trained on large amounts of data, and they operate in two modes. The first one is prompting
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can make this a list. E.g.:

"Mask generation models are trained on large amounts of data, and they operate in two modes: * Prompting mode: the model takes in....

  • Segment everything mode: ...."

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved
docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved
docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved
docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved
docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved
docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved
docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved
@merveenoyan
Copy link
Contributor Author

@MKhalusova thanks, I addressed your comments I think

Copy link
Contributor

@MKhalusova MKhalusova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing the feedback, LGTM!

@MKhalusova
Copy link
Contributor

@ArthurZucker please take a look. the guide LGTM

@ArthurZucker ArthurZucker self-requested a review February 8, 2024 02:32
@khipp
Copy link
Contributor

khipp commented Feb 9, 2024

I hope feedback from the community is welcome. Nice work! 🤗

Copy link
Collaborator

@ArthurZucker ArthurZucker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the nice documentation!

docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved
docs/source/en/tasks/mask_generation.md Outdated Show resolved Hide resolved
@merveenoyan
Copy link
Contributor Author

@ArthurZucker can you merge this if it's ok?

@amyeroberts
Copy link
Collaborator

@merveenoyan I can merge. Thanks for adding this!

@amyeroberts amyeroberts merged commit 3f4e79d into huggingface:main Feb 14, 2024
8 checks passed
sbucaille pushed a commit to sbucaille/transformers that referenced this pull request Feb 14, 2024
* Create mask_generation.md

* add h1

* add to toctree

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update mask_generation.md

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update mask_generation.md

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Arthur <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Klaus Hipp <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Klaus Hipp <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Klaus Hipp <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Arthur <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

* Update mask_generation.md

* Update mask_generation.md

---------

Co-authored-by: NielsRogge <[email protected]>
Co-authored-by: Maria Khalusova <[email protected]>
Co-authored-by: Arthur <[email protected]>
Co-authored-by: Klaus Hipp <[email protected]>
itazap pushed a commit that referenced this pull request May 14, 2024
* Create mask_generation.md

* add h1

* add to toctree

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: NielsRogge <[email protected]>

* Update mask_generation.md

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Maria Khalusova <[email protected]>

* Update mask_generation.md

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Arthur <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Klaus Hipp <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Klaus Hipp <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Klaus Hipp <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

Co-authored-by: Arthur <[email protected]>

* Update docs/source/en/tasks/mask_generation.md

* Update mask_generation.md

* Update mask_generation.md

---------

Co-authored-by: NielsRogge <[email protected]>
Co-authored-by: Maria Khalusova <[email protected]>
Co-authored-by: Arthur <[email protected]>
Co-authored-by: Klaus Hipp <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants